Tangoe Telecom SOAP API

22.2.x
(0 reviews)

> Custom Fields

getCustomFields()

The method returns all existing custom fields for a specified service type ID. The first input parameter must be a valid service type ID (inventory voice/data, equipment, order, cost center or employee). The second one specifies whether the desired custom fields belong to an order (true) or an inventory item (false). The structure of the used objects may be observed in the appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetCustomFieldsRequest>
         <inv:serviceTypeID>?</inv:serviceTypeID>
         <inv:order>?</inv:order>
      </inv:GetCustomFieldsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetCustomFieldsResponse>
         <!--Zero or more repetitions:-->
         <inv:customField>
            <!--Optional:-->
            <inv:id>?</inv:id>
            <inv:name>?</inv:name>
            <inv:value>?</inv:value>
            <!--Optional:-->
            <inv:fieldType>?</inv:fieldType>
            <!--Optional:-->
            <inv:required>?</inv:required>
         </inv:customField>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:GetCustomFieldsResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • The service type for equipment is 1000 + deviceTypeId;

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Data validation error – situations:
    • the provided service type id is not of type voice or data;
    • the requested custom fields could not be retrieved from the database;
  • Operation error, if a database error occurs.

Reviews